4.6 Running the Self-Service App

The installation program creates a shortcut for the Self-Service App, but you can also run the app in the following ways:

• Using a Windows Logon script.

• Using third-party software.

• By putting a shortcut in the Startup program group.

• Using the Windows Scheduler.

• From a hyperlink.

To run the Self-Service App from the command line:

1. Open a command prompt and change to the MyIDApp folder. By default, this is:

   C:\Program Files (x86)\Intercede\MyIDApp\Self Service Application\

2. Type the following, and press Enter:

   MyIDApp.exe

By default, the Self-Service App runs in interactive mode. To run in wizard mode or in automation mode, you must specify the appropriate command-line parameters.

For information about the additional command-line parameters, see section 5, Command line arguments.

4.6.1 Launching the Self-Service App from a hyperlink

When you install the Self-Service App, it registers the myidssa: protocol – this means that you can click on hyperlinks on web pages and email messages to launch the Self-Service App. This allows you to create tailored email notifications from within MyID; for example, to send to a user when there is a new security device to collect.

Note: The myidssa: protocol is also used by the MyID Client for Windows and the MyID Client for Mac. If you have both the Self-Service App and the MyID Client for Windows installed on the same PC, when you click a myidssa: link, you can choose which application to use. The command-line options supported by the MyID Client for Windows and MyID Client for Mac are different; to ensure that the links you create can be used by all three applications, see the Launching the MyID Client for Windows from a hyperlink section in the MyID Client for Windows guide and the Launching the MyID Client for Mac from a hyperlink section in the MyID Client for Mac guide for details of the supported options.

You can use the same command line options as those available at the Windows command prompt – see section 5, Command line arguments for details. If you need to use more than one command line option, use the + symbol to combine them.

Using the hyperlink mechanism, you can specify the following:

• Start the Self-Service App in interactive mode.

  myidssa://

• Start the Self-Service App in wizard mode.

  myidssa:///w

• Start the Self-Service App in wizard mode with no pop-ups.

  myidssa:///w+/nopopup

  Using the bare myidssa:///w link provides no feedback to the end user if there are no jobs to collect – you are recommended to use the myidssa:///w+/nopopup link so that the user can see that the Self-Service App has started and has checked for outstanding jobs.

• Start the Self-Service App to collect a specific task.

  You can use the %jobid placeholder in a MyID email template; this will be substituted with the appropriate job ID when the email message is created.

  For example, if your email template includes the following:

  Click <a href="myidssa:///jobid:%jobid">Self-Service App</a>

  when the email message is created, it would become something similar to:

  Click <a href="myidssa:///jobid:256">Self-Service App</a>

• Start the Self-Service App to collect a specific task for a specific user.

  To make sure that usernames with spaces are dealt with correctly, you must replace the spaces with + signs. For URLs created from email templates, MyID can do this automatically if you use the correct syntax. For example, if your email template includes the following:

  Click <a href="myidssa:///jobid:%jobid+/un:{%logonName:URI}">Self-Service App</a>

  when the email message is created, it would become something similar to:

  Click <a href="myidssa:///jobid:256+/un:Jane+Smith">Self-Service App</a>

When you click a link in another application (for example, in a browser, in an email, or within a document) a warning message may be displayed. Click Allow or Yes (depending on the application) to open the link. You may also be able to deselect the Always ask before opening this type of address to prevent the warning message from appearing again.

Note: The installation program adds protocol registry entries for the current user only when installed by a non-administrator (HKEY_CURRENT_USER), or for all users when installed as an administrator (HKEY_LOCAL_MACHINE). The current user entry takes precedence if both are available. This may cause an issue if different users update the software to different versions in different locations. The registry locations are:

• HKEY_CURRENT_USER\Software\Classes\myidssa

• HKEY_LOCAL_MACHINE\Software\Classes\myidssa